/*
 * File     : FixedSize.java
 * Created  : 1 May 2011
 *
 * Copyright © 2011 Matthew Wilson (mj. {my-surname} .uk {at} gmail.com)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.googlecode.dni;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * <p>
 *  Annotates a parameter or structure field's getter to indicate that the value
 *  is of a fixed size.
 * </p>
 * <p>
 *  TODO DOCUMENT
 * </p>
 *
 * <h3>Examples</h3>
 * <h4>Fixed-size string</h4>
 * <pre>
 * struct fsa_example_1
 * {
 *   char filename[ 256 ];
 * }
 *
 * &#64;Structure
 * interface fs_example_1
 * {
 *   &#64;FixedSize( 256 )
 *   String getFilename();
 *   void setFilename( String filename );
 * }
 * </pre>
 *
 * <h4>Fixed-size array-of-struct with per-element access</h4>
 * <pre>
 * struct fs_example_2
 * {
 *    struct
 *    {
 *      int x;
 *      int y;
 *    } big_array[ 1024 ];
 * }
 *
 * &#64;Structure
 * interface fsa_example_2
 * {
 *   &#64;FixedSize( 1024 )
 *   StructureList&lt; Point &gt; getBigArray();
 *
 *   &#64;Structure
 *   interface Point
 *   {
 *      int getX();
 *      void setX( int x );
 *
 *      int getY();
 *      void setY( int y );
 *   }
 * }
 * </pre>
 *
 * <h4>Fixed-size array-of-byte with per-element access</h4>
 * <pre>
 * struct fsa_example_3
 * {
 *    char big_array[ 1024 ];
 * }
 *
 * &#64;Structure
 * interface fsa_example_3
 * {
 *   &#64;FixedSize( 1024 )
 *   ByteBuffer getBigArray();
 * }
 * </pre>
 *
 * @author Matthew Wilson
 */
@Retention( RetentionPolicy.RUNTIME )
@Target( ElementType.METHOD )
@Documented
public @interface FixedSize
{

    /**
     * The length of the value.
     *
     * @return the length of the value, in units of the field type
     */
    int value();

}
